pp108 : GetXMLObject (CoBOC) (Deprecated)

GetXMLObject (CoBOC) (Deprecated)

This method is used to retrieve objects, templates, and folders. GetXMLObject is part of the CoBOC Methodset 4.2 in the Cordys CoBOC application package.

SOAP Request

<GetXMLObject xmlns="http://schemas.cordys.com/1.0/coboc">
    <key
        filter="/Sales Processing Folder/CustomerTemplate;/Purchase Folder/POTemplate"
        type="instance" version="organization">/Sales Processing Folder/o12</key>
</GetXMLObject>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

filter

Contains the filter to be set for retrieving different types of content

String

The following table refers tothe input values of the type attribute.

  • To retrieve an object, set attribute to path of the template. You can also specify multiple filters by separating each filter with a semicolon. For example, /Sales Process/Customer; /Purchase Process/Customer.
  • To retrieve a folder, set attribute to folder.
  • To retrieve a template-less object, set attribute to /SUPERTEMPLATE.

type

Contains the type to be set for retrieving different types of content

String

The following table refers tothe input values of the type attribute.

  • To retrieve an object, set attribute to instance.
  • To retrieve a folder, set attribute to entity.
  • To retrieve a template-less object, set attribute to instance.

version

Contains the version of the type of content

String

The supported versions are

  • user
  • organization
  • isv
    If you don't provide the version, the system first searches in the user space, followed by the organization space, and then in the isv space.

key

Contains the name of the object along with the full path, for retrieving different types of content.

String

The following table refers to the input values of the key attribute.

  • To retrieve an object, set attribute to the name of the object along with the path.
  • To retrieve a folder, set attribute to the name of the object along with the path. You can also specify a path that is shared. To do so precede the folder path with shared/; for example, shared/ Sales Process Folder.
  • To retrieve a template-less object, set attribute to the name of the object along with the path.

SOAP Response

<GetXMLObjectResponse xmlns="http://schemas.cordys.com/1.0/coboc">
    <tuple key="/Sales Processing Folder/o12"
        lastModified="1048158196631" level="organization" name="o12">
        <old>
            <ENTITY>
                <ENTITY_ID>1048155566232</ENTITY_ID>
                <PARENT_ID>1048155566231</PARENT_ID>
                <ORGANIZATION>o=system,cn=cordys,o=vanenburg.com</ORGANIZATION>
                <OWNER>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</OWNER>
                <DESCRIPTION/>
            </ENTITY>
        </old>
    </tuple>
</GetXMLObjectResponse>

Response Parameters

Parameter

Description

lastModified

Contains the last date and time of modification of the object. This information can be used while updating the object.

key

Name of the object along with the full path.

name

Name of the object.

level

Version of the object (user, organization, or isv)

ENTITY_ID

ID of the object.

PARENT_ID

ID of the parent folder of the object.

ORGANIZATION

Organization DN of the object's owner.

OWNER

DN of the object's owner.

DESCRIPTION

Description of the object.